/*
 *  SPAGL Copyright (C) 2008 Sam Pottinger
 *  This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser 
 *  General Public License as published by the Free Software Foundation; either version 2.1 of the License, or 
 *  (at your option) any later version. This library is distributed in the hope that it will be useful, but 
 *  WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 
 *  See the GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License along with this library; if not, 
 *  write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 
 */

package spagcore;

/**
 * An interface to standardize the use of checkboxes
 * @author Sam Pottinger
 */
public interface SpaglCoreCheckBox extends SpaglCoreWidget, SpaglFontCapable, SpaglImageCapable, SpaglCoreEventGenerator {
	
	/**
	 * Sets the text displayed to the right of this widget
	 * 
	 * @param newText the text that will be associated with the object
	 */
	public void setText(String newText);
	
	/**
	 * Get the text on the right of the widget
	 * 
	 * @return The text associated with the check box
	 */
	public String getText();
	
	/**
	 * Set the selection state of the widget
	 * 
	 * @param newValue True if this widget will display a check mark or false if it is to be empty
	 */
	public void setSelected(boolean newValue);
	
	/**
	 * Determines if the widget is selected
	 * 
	 * @return True if the widget is selected or false if it is not
	 */
	public boolean isSelected();

}
